Vcenter NamespaceManagement Networks Edges NSXConfig

Vcenter NamespaceManagement Networks Edges NSXConfig schema describes the configuration for NSX Edge services.

This schema was added in vSphere API 8.0.0.1.

JSON Example

{
    "edge_cluster_id": "string",
    "default_ingress_tls_certificate": "string",
    "routing_mode": "string",
    "egress_ip_ranges": [
        {
            "address": "string",
            "count": 0
        }
    ],
    "t0_gateway": "string",
    "load_balancer_size": "string"
}

string

edge_cluster_id

Optional

Vcenter NamespaceManagement Networks Edges NSXConfig.edge_cluster_ID defines the NSX Edge Cluster to be used for Kubernetes Services of type LoadBalancer, Kubernetes Ingresses, and NSX SNAT.

This property was added in vSphere API 8.0.0.1.

Defaults to a the edge cluster created earliest.

string

default_ingress_tls_certificate

Optional

Vcenter NamespaceManagement Networks Edges NSXConfig.default_ingress_TLS_certificate defines a default certificate that is served on Ingress services, when another certificate is not presented. This configuration applies to all namespaces by default.

This property was added in vSphere API 8.0.0.1.

If unset, there will be no certificate served on Ingress.

string

routing_mode

Optional

Vcenter NamespaceManagement Networks Edges NSXConfig.routing_mode enables the network topology in either NAT mode or Routed Mode. Enabling routed mode will result in all the workloads i.e vSphere PODs, VMs and Kubernetes Clusters Node IPs to be directly accessible from networks beyond the Tier-0 router. Once a namespace mode is applied, it cannot be changed.

For more information see: Vcenter NamespaceManagement Networks Edges NSXRoutingMode.

This property was added in vSphere API 8.0.0.1.

The default setting is NAT mode.

array of Vcenter NamespaceManagement Networks IPRange

egress_ip_ranges

Optional

Vcenter NamespaceManagement Networks Edges NSXConfig.egress_IP_ranges lists the IP Ranges from which NSX assigns IP addresses used for performing SNAT from container IPs to external IPs. These ranges must not overlap with other IP ranges on this network.

This property was added in vSphere API 8.0.0.1.

If this range is empty, network traffic will not be able to exit the cluster.

string

t0_gateway

Optional

Vcenter NamespaceManagement Networks Edges NSXConfig.t0_gateway specifies the default Tier-0 gateway ID for the namespaces configuration.

This property was added in vSphere API 8.0.0.1.

If unset, the default Tier-0 gateway from the edge cluster is used.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: NSXTier0Gateway. When operations return a value of this schema as a response, the property will be an identifier for the resource type: NSXTier0Gateway.

string

load_balancer_size

Optional

Vcenter NamespaceManagement Networks Edges NSXConfig.load_balancer_size describes the load balancer sizing options available. Larger sizes support more active virtual servers, but consume more resources.

For more information see: Vcenter NamespaceManagement Networks Edges LoadBalancerSize.

This property was added in vSphere API 8.0.0.1.

If unset, the size defaults to small.